Add use case for getting dataset versions #402
Conversation
scolapasta
moved this from Ready for Triage
to Ready for Review ⏩
in IQSS Dataverse Project
cmbz
added
FY26 Sprint 11
ekraffmiller
left a comment
ekraffmiller
left a comment
There was a problem hiding this comment.
Hi @vera, thanks for your PR. We don't currently need this use case in our SPA, because we use GetDatasetVersionsSummaries, and GetDatasetVersionDiff to display a list of Dataset versions. But since it is available on the Dataverse API I think it's ok to add. The only caveat I have is to not return the list of files, for performance reasons.
| - **limit**: (number) Limit for pagination. | ||
| - **offset**: (number) Offset for pagination. | ||
| - **excludeMetadataBlocks**: (boolean) Exclude metadata blocks (default: false). | ||
| - **excludesFiles**: (boolean) Exclude files (default: true). |
There was a problem hiding this comment.
I think returning the complete list of files in the response could be a problem - some of our datasets have several thousand files. We have another use case, GetDatasetFiles, which returns the files with pagination. My suggestion is to remove files from the response, and use the other use case to get the files with pagination.
4 participants
What this PR does / why we need it:
This PR adds code for using the "List Versions of a Dataset" API.
Which issue(s) this PR closes:
I'm not aware of an open issue.
Related Dataverse PRs:
Special notes for your reviewer:
/
Suggestions on how to test this:
I've added tests and docs on how to use.
Is there a release notes or changelog update needed for this change?:
Yes
Additional documentation:
/